楽天ペイv2随時利用承諾 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranRakutenpay 取引登録

これ以降の利用承諾で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
JobCd	jobCd	必須処理区分 REGISTER：申込
Amount	amount	必須半角数字7桁利用金額「0」を設定します。

URL

/payment/EntryTranRakutenpay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "REGISTER",
  "amount": "0"
}

URL

/payment/EntryTranRakutenpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=REGISTER&Amount=0

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "467d50a6bc03dabe1713f8d49042bd96",
  "accessPass": "bfa37e690fdcc229b2c5185228ace517"
}

レスポンスパラメータ：正常系

AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranRakutenpay 決済実行

これ以降の決済取引で必要となるトークンと遷移URLを返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
RetURL	retURL	必須半角英数記号256桁決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。楽天ペイ決済上でお客様が決済手続きを正常に完了された場合に、指定されたURLに結果をリダイレクト経由で送信されます。
PaymentTermSec	paymentTermSec	半角数字4桁支払開始期限秒未指定の場合は120が設定されます。最大は1800（30分）です。
Description	description	全半角300桁楽天説明文設定内容はこちら
SubscriptionName	subscriptionName	必須全半角200桁サブスクリプション名称
SubscriptionAmount	subscriptionAmount	半角数字7桁サブスクリプション利用金額

URL

/payment/ExecTranRakutenpay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "retURL": "https://example.com/receive/success",
  "subscriptionName": "サブスクリプション名称"
}

URL

/payment/ExecTranRakutenpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success&SubscriptionName=サブスクリプション名称

レスポンス

正常

AccessID	accessID	必須半角英数32桁固定取引ID
Token	token	必須半角英数記号256桁固定トークン支払手続き開始に利用するハッシュ値です。
StartURL	startURL	必須半角英数記号256桁支払手続き開始IFのURL
StartLimitDate	startLimitDate	必須半角数字14桁固定支払開始期限日時 yyyyMMddHHmmss書式

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "467d50a6bc03dabe1713f8d49042bd96",
  "token": "wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F",
  "startURL": "https://x01.mul-pay.jp/payment/RakutenpayStart.idPass",
  "startLimitDate": "20210501000000"
}

レスポンスパラメータ：正常系

AccessID=467d50a6bc03dabe1713f8d49042bd96&Token=wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F&StartURL=https://x01.mul-pay.jp/payment/RakutenpayStart.idPass&StartLimitDate=20210501000000

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenpayStart 支払手続き開始IFの呼び出し

楽天ペイ（オンライン決済）V2において、お客様を楽天ペイの認証画面へと遷移させる必要があります。加盟店様はリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。当サービスは各種パラメータを設定し、お客様を楽天ペイの認証画面に誘導します。 ※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		必須半角英数256桁固定トークン【決済実行】で発行された値を設定します。

URL

/payment/RakutenpayStart.idPass

リクエストパラメータ

AccessID=467d50a6bc03dabe1713f8d49042bd96&Token=wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F

リダイレクトページサンプル


<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="RakutenpayStartCall" action="{RakutenpayStartURL}" method="POST">
    <noscript>
      <center>
        <h2>楽天ペイの決済画面へ遷移します。</h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.RakutenpayStartCall.submit();
      }
    //-->
    </script>
  </body>
</html>

決済結果受信

当サービスはお客様が支払操作を完了または中止した際に、【決済実行】で指定した決済結果戻しURLに決済結果を通知します。
ブラウザを×ボタンで閉じた場合など、ユーザの操作方法によっては利用承諾操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にてご確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID
Status		必須現状態処理成功時・REGISTER 処理失敗時・PAYFAIL
TranDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
RakutenChargeID		半角英数記号32桁楽天チャージID 利用承諾の場合は返却しません。
RakutenSubscriptionID		必須半角英数字15桁楽天サブスクリプションID
CheckString		必須改ざんチェック文字列 OrderID,AccessID,ShopID,ShopPass,RakutenChargeID,Statusを連結しSHA256のハッシュ値を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=REGISTER&TranDate=20210415110000&RakutenChargeID=&RakutenSubscriptionID=sub_XXXXXXXXXXX&CheckString=123fe4567ce89e8a0fc12e34567e14bda475561c469c99dc1dc3c4fec9089438

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenpayAcceptUpdate 利用承諾変更

指定したサブスクリプションIDの内容を変更することが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
SubscriptionName	subscriptionName	必須全半角200桁サブスクリプション名称変更後のサブスクリプション名称を指定してください。

URL

/payment/RakutenpayAcceptUpdate.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "467d50a6bc03dabe1713f8d49042bd96",
  "accessPass": "bfa37e690fdcc229b2c5185228ace517",
  "orderID": "ORDER0000001",
  "subscriptionName": "テスト商品名"
}

URL

/payment/RakutenpayAcceptUpdate.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&SubscriptionName=テスト商品名

レスポンス

正常

OrderID		orderID		必須半角英数記号27桁オーダーID
Status		status		必須現状態

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "REGISTER"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REGISTER

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeRakutenpay/SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
PayType	payType	半角数字2桁決済方法 SearchTradeMultiをご利用の際は「50」を指定してください。 SearchTradeRakutenpayをご利用の際は設定不要です。

URL

/payment/SearchTradeRakutenpay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}

URL：SearchTradeRakutenpayの場合

/payment/SearchTradeRakutenpay.idPass

URL：SearchTradeMultiの場合

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=50

レスポンス

正常

Status	status	必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 PAYFAIL：決済失敗 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 REGISTER：申込 CANCEL：キャンセル RETURN：返品 EXPIRED：期限切れ
ProcessDate	processDate	必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd	jobCd	必須処理区分 AUTH：仮売上 CAPTURE：即時売上 SALES：実売上 REGISTER：申込 CANCEL：キャンセル RETURN：返品 CHANGE：金額変更 ACCCEPTUPDATE：利用承諾変更
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料
ClientField1	clientField1	必須全半角100バイト加盟店自由項目1
ClientField2	clientField2	必須全半角100バイト加盟店自由項目2
ClientField3	clientField3	必須全半角100バイト加盟店自由項目3
PayType	payType	必須半角数字2桁決済方法 50：楽天ペイ（オンライン決済）V2
RakutenChargeID	rakutenChargeID	半角英数記号32桁楽天チャージID
ReauthLimitDate	reauthLimitDate	半角数字14桁固定仮売上有効期限延長期限 yyyyMMddHHmmss書式
SalesLimitDate	salesLimitDate	半角数字14桁固定実売上期限 yyyyMMddHHmmss書式
ChangeLimitDate	changeLimitDate	半角数字14桁固定金額変更期限 yyyyMMddHHmmss書式
CancelLimitDate	cancelLimitDate	半角数字14桁固定キャンセル期限 yyyyMMddHHmmss書式
RakutenPoint	rakutenPoint	半角数字7桁楽天ペイで使用されたポイント
RakutenSubscriptionType	rakutenSubscriptionType	半角英字10桁サブスクリプションタイプ空で返却します。
RakutenSubscriptionID	rakutenSubscriptionID	半角英数記号15桁サブスクリプションID 楽天ペイが発行したサブスクリプションIDを返却します。
RakutenSettlementSubscriptionID	rakutenSettlementSubscriptionID	半角英数記号15桁随時決済時に用いたサブスクリプションID 空で返却します。
RakutenSubscriptionCurrentStatus	rakutenSubscriptionCurrentStatus	サブスクリプション現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 PAYFAIL：決済失敗 REGISTER：申込 EXPIRED：期限切れ
RakutenSubscriptionStartDate	rakutenSubscriptionStartDate	半角数字14桁固定利用承諾日付 yyyyMMddHHmmss書式
RakutenSubscriptionAmount	rakutenSubscriptionAmount	半角数字7桁利用承諾金額利用承諾時に指定した金額を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "status": "REGISTER",
  "processDate": "20210308125035",
  "jobCd": "REGISTER",
  "accessID": "2bb0da27c4cf3e95b810509bb4541397",
  "accessPass": "fb8f3d9c7408e8eb47448010d356cd58",
  "amount": "0",
  "tax": "0",
  "clientField1": "",
  "clientField2": "",
  "clientField3": "",
  "payType": "50",
  "rakutenChargeID": "",
  "reauthLimitDate": "",
  "salesLimitDate": "",
  "changeLimitDate": "",
  "cancelLimitDate": "",
  "rakutenPoint": "",
  "rakutenSubscriptionType": "REGISTER",
  "rakutenSubscriptionID": "sub_XXXXXXXXXXX",
  "rakutenSettlementSubscriptionID": "",
  "rakutenSubscriptionCurrentStatus": "REGISTER",
  "rakutenSubscriptionStartDate": "20210308125035",
  "rakutenSubscriptionAmount": "1000"
}

レスポンスパラメータ：正常系

Status=REGISTER&ProcessDate=20210308125035&JobCd=REGISTER&AccessID=2bb0da27c4cf3e95b810509bb4541397&AccessPass=fb8f3d9c7408e8eb47448010d356cd58&Amount=0&Tax=0&ClientField1=&ClientField2=&ClientField3=&PayType=50&RakutenChargeID=&ReauthLimitDate=&SalesLimitDate=&ChangeLimitDate=&CancelLimitDate=&RakutenPoint=&RakutenSubscriptionType=&RakutenSubscriptionID=sub_XXXXXXXXXXX&RakutenSettlementSubscriptionID=&RakutenSubscriptionCurrentStatus=REGISTER&RakutenSubscriptionStartDate=20210308125035&RakutenSubscriptionAmount=1000

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

楽天ペイ(オンライン決済)V2